<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpgradient: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-data.html" title="Data Objects">
<link rel="prev" href="libgimp3-gimpfonts.html" title="gimpfonts">
<link rel="next" href="libgimp3-gimpgradients.html" title="gimpgradients">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp3-gimpgradient.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-data.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp3-gimpfonts.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp3-gimpgradients.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp3-gimpgradient"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp3-gimpgradient.top_of_page"></a>gimpgradient</span></h2>
<p>gimpgradient — Functions operating on a single gradient.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp3-gimpgradient.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-new" title="gimp_gradient_new ()">gimp_gradient_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-duplicate" title="gimp_gradient_duplicate ()">gimp_gradient_duplicate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-rename" title="gimp_gradient_rename ()">gimp_gradient_rename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-delete" title="gimp_gradient_delete ()">gimp_gradient_delete</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-is-editable" title="gimp_gradient_is_editable ()">gimp_gradient_is_editable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-get-uniform-samples" title="gimp_gradient_get_uniform_samples ()">gimp_gradient_get_uniform_samples</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-get-custom-samples" title="gimp_gradient_get_custom_samples ()">gimp_gradient_get_custom_samples</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-get-number-of-segments" title="gimp_gradient_get_number_of_segments ()">gimp_gradient_get_number_of_segments</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-get-left-color" title="gimp_gradient_segment_get_left_color ()">gimp_gradient_segment_get_left_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-set-left-color" title="gimp_gradient_segment_set_left_color ()">gimp_gradient_segment_set_left_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-get-right-color" title="gimp_gradient_segment_get_right_color ()">gimp_gradient_segment_get_right_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-set-right-color" title="gimp_gradient_segment_set_right_color ()">gimp_gradient_segment_set_right_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-get-left-pos" title="gimp_gradient_segment_get_left_pos ()">gimp_gradient_segment_get_left_pos</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-set-left-pos" title="gimp_gradient_segment_set_left_pos ()">gimp_gradient_segment_set_left_pos</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-get-middle-pos" title="gimp_gradient_segment_get_middle_pos ()">gimp_gradient_segment_get_middle_pos</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-set-middle-pos" title="gimp_gradient_segment_set_middle_pos ()">gimp_gradient_segment_set_middle_pos</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-get-right-pos" title="gimp_gradient_segment_get_right_pos ()">gimp_gradient_segment_get_right_pos</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-set-right-pos" title="gimp_gradient_segment_set_right_pos ()">gimp_gradient_segment_set_right_pos</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-get-blending-function" title="gimp_gradient_segment_get_blending_function ()">gimp_gradient_segment_get_blending_function</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-get-coloring-type" title="gimp_gradient_segment_get_coloring_type ()">gimp_gradient_segment_get_coloring_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-range-set-blending-function" title="gimp_gradient_segment_range_set_blending_function ()">gimp_gradient_segment_range_set_blending_function</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-range-set-coloring-type" title="gimp_gradient_segment_range_set_coloring_type ()">gimp_gradient_segment_range_set_coloring_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-range-flip" title="gimp_gradient_segment_range_flip ()">gimp_gradient_segment_range_flip</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-range-replicate" title="gimp_gradient_segment_range_replicate ()">gimp_gradient_segment_range_replicate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-range-split-midpoint" title="gimp_gradient_segment_range_split_midpoint ()">gimp_gradient_segment_range_split_midpoint</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-range-split-uniform" title="gimp_gradient_segment_range_split_uniform ()">gimp_gradient_segment_range_split_uniform</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-range-delete" title="gimp_gradient_segment_range_delete ()">gimp_gradient_segment_range_delete</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-range-redistribute-handles" title="gimp_gradient_segment_range_redistribute_handles ()">gimp_gradient_segment_range_redistribute_handles</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-range-blend-colors" title="gimp_gradient_segment_range_blend_colors ()">gimp_gradient_segment_range_blend_colors</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-range-blend-opacity" title="gimp_gradient_segment_range_blend_opacity ()">gimp_gradient_segment_range_blend_opacity</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgradient.html#gimp-gradient-segment-range-move" title="gimp_gradient_segment_range_move ()">gimp_gradient_segment_range_move</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-gimpgradient.description"></a><h2>Description</h2>
<p>Functions operating on a single gradient.</p>
</div>
<div class="refsect1">
<a name="libgimp3-gimpgradient.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-gradient-new"></a><h3>gimp_gradient_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_gradient_new (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Creates a new gradient</p>
<p>This procedure creates a new, uninitialized gradient</p>
<div class="refsect3">
<a name="gimp-gradient-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The requested name of the new gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-new.returns"></a><h4>Returns</h4>
<p>The actual new gradient name.
The returned value must be freed with <code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-duplicate"></a><h3>gimp_gradient_duplicate ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_gradient_duplicate (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Duplicates a gradient</p>
<p>This procedure creates an identical gradient by a different name</p>
<div class="refsect3">
<a name="gimp-gradient-duplicate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-duplicate.returns"></a><h4>Returns</h4>
<p>The name of the gradient's copy.
The returned value must be freed with <code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-rename"></a><h3>gimp_gradient_rename ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_gradient_rename (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                      <em class="parameter"><code>const <span class="type">gchar</span> *new_name</code></em>);</pre>
<p>Rename a gradient</p>
<p>This procedure renames a gradient</p>
<div class="refsect3">
<a name="gimp-gradient-rename.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_name</p></td>
<td class="parameter_description"><p>The new name of the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-rename.returns"></a><h4>Returns</h4>
<p>The actual new name of the gradient.
The returned value must be freed with <code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-delete"></a><h3>gimp_gradient_delete ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_delete (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Deletes a gradient</p>
<p>This procedure deletes a gradient</p>
<div class="refsect3">
<a name="gimp-gradient-delete.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-delete.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-is-editable"></a><h3>gimp_gradient_is_editable ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_is_editable (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Tests if gradient can be edited</p>
<p>Returns TRUE if you have permission to change the gradient</p>
<div class="refsect3">
<a name="gimp-gradient-is-editable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-is-editable.returns"></a><h4>Returns</h4>
<p> TRUE if the gradient can be edited.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-get-uniform-samples"></a><h3>gimp_gradient_get_uniform_samples ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_get_uniform_samples (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                   <em class="parameter"><code><span class="type">gint</span> num_samples</code></em>,
                                   <em class="parameter"><code><span class="type">gboolean</span> reverse</code></em>,
                                   <em class="parameter"><code><span class="type">gint</span> *num_color_samples</code></em>,
                                   <em class="parameter"><code><span class="type">gdouble</span> **color_samples</code></em>);</pre>
<p>Sample the specified in uniform parts.</p>
<p>This procedure samples the active gradient in the specified number
of uniform parts. It returns a list of floating-point values which
correspond to the RGBA values for each sample. The minimum number of
samples to take is 2, in which case the returned colors will
correspond to the { 0.0, 1.0 } positions in the gradient. For
example, if the number of samples is 3, the procedure will return
the colors at positions { 0.0, 0.5, 1.0 }.</p>
<div class="refsect3">
<a name="gimp-gradient-get-uniform-samples.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_samples</p></td>
<td class="parameter_description"><p>The number of samples to take.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>reverse</p></td>
<td class="parameter_description"><p>Use the reverse gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_color_samples</p></td>
<td class="parameter_description"><p>Length of the color_samples array (4 * num_samples). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>color_samples</p></td>
<td class="parameter_description"><p>Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_color_samples][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-get-uniform-samples.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-get-custom-samples"></a><h3>gimp_gradient_get_custom_samples ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_get_custom_samples (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                  <em class="parameter"><code><span class="type">gint</span> num_samples</code></em>,
                                  <em class="parameter"><code>const <span class="type">gdouble</span> *positions</code></em>,
                                  <em class="parameter"><code><span class="type">gboolean</span> reverse</code></em>,
                                  <em class="parameter"><code><span class="type">gint</span> *num_color_samples</code></em>,
                                  <em class="parameter"><code><span class="type">gdouble</span> **color_samples</code></em>);</pre>
<p>Sample the specified gradient in custom positions.</p>
<p>This procedure samples the active gradient in the specified number
of points. The procedure will sample the gradient in the specified
positions from the list. The left endpoint of the gradient
corresponds to position 0.0, and the right endpoint corresponds to
1.0. The procedure returns a list of floating-point values which
correspond to the RGBA values for each sample.</p>
<div class="refsect3">
<a name="gimp-gradient-get-custom-samples.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_samples</p></td>
<td class="parameter_description"><p>The number of samples to take.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>positions</p></td>
<td class="parameter_description"><p>The list of positions to sample along the gradient. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_samples][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>reverse</p></td>
<td class="parameter_description"><p>Use the reverse gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_color_samples</p></td>
<td class="parameter_description"><p>Length of the color_samples array (4 * num_samples). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>color_samples</p></td>
<td class="parameter_description"><p>Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_color_samples][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-get-custom-samples.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-get-number-of-segments"></a><h3>gimp_gradient_get_number_of_segments ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_gradient_get_number_of_segments (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Returns the number of segments of the specified gradient</p>
<p>This procedure returns the number of segments of the specified
gradient.</p>
<div class="refsect3">
<a name="gimp-gradient-get-number-of-segments.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-get-number-of-segments.returns"></a><h4>Returns</h4>
<p> Number of segments.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-6.html#api-index-2.6">2.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-get-left-color"></a><h3>gimp_gradient_segment_get_left_color ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_get_left_color (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                      <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                      <em class="parameter"><code><a href="../html/libgimpcolor3-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>,
                                      <em class="parameter"><code><span class="type">gdouble</span> *opacity</code></em>);</pre>
<p>Retrieves the left endpoint color of the specified segment</p>
<p>This procedure retrieves the left endpoint color of the specified
segment of the specified gradient.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-get-left-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>The return color. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>The opacity of the endpoint. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-get-left-color.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-set-left-color"></a><h3>gimp_gradient_segment_set_left_color ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_set_left_color (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                      <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                      <em class="parameter"><code>const <a href="../html/libgimpcolor3-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>,
                                      <em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>);</pre>
<p>Sets the left endpoint color of the specified segment</p>
<p>This procedure sets the left endpoint color of the specified segment
of the specified gradient.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-set-left-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>The color to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>The opacity to set for the endpoint.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-set-left-color.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-get-right-color"></a><h3>gimp_gradient_segment_get_right_color ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_get_right_color (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                       <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                       <em class="parameter"><code><a href="../html/libgimpcolor3-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>,
                                       <em class="parameter"><code><span class="type">gdouble</span> *opacity</code></em>);</pre>
<p>Retrieves the right endpoint color of the specified segment</p>
<p>This procedure retrieves the right endpoint color of the specified
segment of the specified gradient.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-get-right-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>The return color. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>The opacity of the endpoint. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-get-right-color.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-set-right-color"></a><h3>gimp_gradient_segment_set_right_color ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_set_right_color (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                       <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                       <em class="parameter"><code>const <a href="../html/libgimpcolor3-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>,
                                       <em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>);</pre>
<p>Sets the right endpoint color of the specified segment</p>
<p>This procedure sets the right endpoint color of the specified
segment of the specified gradient.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-set-right-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>The color to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>The opacity to set for the endpoint.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-set-right-color.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-get-left-pos"></a><h3>gimp_gradient_segment_get_left_pos ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_get_left_pos (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                    <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                    <em class="parameter"><code><span class="type">gdouble</span> *pos</code></em>);</pre>
<p>Retrieves the left endpoint position of the specified segment</p>
<p>This procedure retrieves the left endpoint position of the specified
segment of the specified gradient.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-get-left-pos.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pos</p></td>
<td class="parameter_description"><p>The return position. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-get-left-pos.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-set-left-pos"></a><h3>gimp_gradient_segment_set_left_pos ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_set_left_pos (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                    <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                    <em class="parameter"><code><span class="type">gdouble</span> pos</code></em>,
                                    <em class="parameter"><code><span class="type">gdouble</span> *final_pos</code></em>);</pre>
<p>Sets the left endpoint position of the specified segment</p>
<p>This procedure sets the left endpoint position of the specified
segment of the specified gradient. The final position will be
between the position of the middle point to the left to the middle
point of the current segment.
This procedure returns the final position.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-set-left-pos.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pos</p></td>
<td class="parameter_description"><p>The position to set the guidepoint to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>final_pos</p></td>
<td class="parameter_description"><p>The return position. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-set-left-pos.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-get-middle-pos"></a><h3>gimp_gradient_segment_get_middle_pos ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_get_middle_pos (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                      <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                      <em class="parameter"><code><span class="type">gdouble</span> *pos</code></em>);</pre>
<p>Retrieves the middle point position of the specified segment</p>
<p>This procedure retrieves the middle point position of the specified
segment of the specified gradient.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-get-middle-pos.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pos</p></td>
<td class="parameter_description"><p>The return position. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-get-middle-pos.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-set-middle-pos"></a><h3>gimp_gradient_segment_set_middle_pos ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_set_middle_pos (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                      <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                      <em class="parameter"><code><span class="type">gdouble</span> pos</code></em>,
                                      <em class="parameter"><code><span class="type">gdouble</span> *final_pos</code></em>);</pre>
<p>Sets the middle point position of the specified segment</p>
<p>This procedure sets the middle point position of the specified
segment of the specified gradient. The final position will be
between the two endpoints of the segment.
This procedure returns the final position.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-set-middle-pos.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pos</p></td>
<td class="parameter_description"><p>The position to set the guidepoint to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>final_pos</p></td>
<td class="parameter_description"><p>The return position. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-set-middle-pos.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-get-right-pos"></a><h3>gimp_gradient_segment_get_right_pos ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_get_right_pos (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                     <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                     <em class="parameter"><code><span class="type">gdouble</span> *pos</code></em>);</pre>
<p>Retrieves the right endpoint position of the specified segment</p>
<p>This procedure retrieves the right endpoint position of the
specified segment of the specified gradient.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-get-right-pos.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pos</p></td>
<td class="parameter_description"><p>The return position. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-get-right-pos.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-set-right-pos"></a><h3>gimp_gradient_segment_set_right_pos ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_set_right_pos (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                     <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                     <em class="parameter"><code><span class="type">gdouble</span> pos</code></em>,
                                     <em class="parameter"><code><span class="type">gdouble</span> *final_pos</code></em>);</pre>
<p>Sets the right endpoint position of the specified segment</p>
<p>This procedure sets the right endpoint position of the specified
segment of the specified gradient. The final position will be
between the position of the middle point of the current segment and
the middle point of the segment to the right.
This procedure returns the final position.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-set-right-pos.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pos</p></td>
<td class="parameter_description"><p>The position to set the guidepoint to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>final_pos</p></td>
<td class="parameter_description"><p>The return position. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-set-right-pos.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-get-blending-function"></a><h3>gimp_gradient_segment_get_blending_function ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_get_blending_function
                               (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpGradientSegmentType"><span class="type">GimpGradientSegmentType</span></a> *blend_func</code></em>);</pre>
<p>Retrieves the gradient segment's blending function</p>
<p>This procedure retrieves the blending function of the segment at the
specified gradient name and segment index.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-get-blending-function.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>blend_func</p></td>
<td class="parameter_description"><p>The blending function of the segment. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-get-blending-function.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-get-coloring-type"></a><h3>gimp_gradient_segment_get_coloring_type ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_get_coloring_type
                               (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> segment</code></em>,
                                <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpGradientSegmentColor"><span class="type">GimpGradientSegmentColor</span></a> *coloring_type</code></em>);</pre>
<p>Retrieves the gradient segment's coloring type</p>
<p>This procedure retrieves the coloring type of the segment at the
specified gradient name and segment index.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-get-coloring-type.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segment</p></td>
<td class="parameter_description"><p>The index of the segment within the gradient.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>coloring_type</p></td>
<td class="parameter_description"><p>The coloring type of the segment. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-get-coloring-type.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-range-set-blending-function"></a><h3>gimp_gradient_segment_range_set_blending_function ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_range_set_blending_function
                               (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> start_segment</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> end_segment</code></em>,
                                <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpGradientSegmentType"><span class="type">GimpGradientSegmentType</span></a> blending_function</code></em>);</pre>
<p>Change the blending function of a segments range</p>
<p>This function changes the blending function of a segment range to
the specified blending function.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-range-set-blending-function.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_segment</p></td>
<td class="parameter_description"><p>The index of the first segment to operate on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_segment</p></td>
<td class="parameter_description"><p>The index of the last segment to operate on. If negative, the selection will extend to the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>blending_function</p></td>
<td class="parameter_description"><p>The blending function.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-range-set-blending-function.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-range-set-coloring-type"></a><h3>gimp_gradient_segment_range_set_coloring_type ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_range_set_coloring_type
                               (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> start_segment</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> end_segment</code></em>,
                                <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpGradientSegmentColor"><span class="type">GimpGradientSegmentColor</span></a> coloring_type</code></em>);</pre>
<p>Change the coloring type of a segments range</p>
<p>This function changes the coloring type of a segment range to the
specified coloring type.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-range-set-coloring-type.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_segment</p></td>
<td class="parameter_description"><p>The index of the first segment to operate on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_segment</p></td>
<td class="parameter_description"><p>The index of the last segment to operate on. If negative, the selection will extend to the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>coloring_type</p></td>
<td class="parameter_description"><p>The coloring type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-range-set-coloring-type.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-range-flip"></a><h3>gimp_gradient_segment_range_flip ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_range_flip (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                  <em class="parameter"><code><span class="type">gint</span> start_segment</code></em>,
                                  <em class="parameter"><code><span class="type">gint</span> end_segment</code></em>);</pre>
<p>Flip the segment range</p>
<p>This function flips a segment range.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-range-flip.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_segment</p></td>
<td class="parameter_description"><p>The index of the first segment to operate on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_segment</p></td>
<td class="parameter_description"><p>The index of the last segment to operate on. If negative, the selection will extend to the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-range-flip.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-range-replicate"></a><h3>gimp_gradient_segment_range_replicate ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_range_replicate (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                       <em class="parameter"><code><span class="type">gint</span> start_segment</code></em>,
                                       <em class="parameter"><code><span class="type">gint</span> end_segment</code></em>,
                                       <em class="parameter"><code><span class="type">gint</span> replicate_times</code></em>);</pre>
<p>Replicate the segment range</p>
<p>This function replicates a segment range a given number of times.
Instead of the original segment range, several smaller scaled copies
of it will appear in equal widths.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-range-replicate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_segment</p></td>
<td class="parameter_description"><p>The index of the first segment to operate on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_segment</p></td>
<td class="parameter_description"><p>The index of the last segment to operate on. If negative, the selection will extend to the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>replicate_times</p></td>
<td class="parameter_description"><p>The number of times to replicate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-range-replicate.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-range-split-midpoint"></a><h3>gimp_gradient_segment_range_split_midpoint ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_range_split_midpoint
                               (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> start_segment</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> end_segment</code></em>);</pre>
<p>Splits each segment in the segment range at midpoint</p>
<p>This function splits each segment in the segment range at its
midpoint.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-range-split-midpoint.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_segment</p></td>
<td class="parameter_description"><p>The index of the first segment to operate on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_segment</p></td>
<td class="parameter_description"><p>The index of the last segment to operate on. If negative, the selection will extend to the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-range-split-midpoint.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-range-split-uniform"></a><h3>gimp_gradient_segment_range_split_uniform ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_range_split_uniform
                               (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> start_segment</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> end_segment</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> split_parts</code></em>);</pre>
<p>Splits each segment in the segment range uniformly</p>
<p>This function splits each segment in the segment range uniformly
according to the number of times specified by the parameter.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-range-split-uniform.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_segment</p></td>
<td class="parameter_description"><p>The index of the first segment to operate on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_segment</p></td>
<td class="parameter_description"><p>The index of the last segment to operate on. If negative, the selection will extend to the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>split_parts</p></td>
<td class="parameter_description"><p>The number of uniform divisions to split each segment to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-range-split-uniform.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-range-delete"></a><h3>gimp_gradient_segment_range_delete ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_range_delete (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                    <em class="parameter"><code><span class="type">gint</span> start_segment</code></em>,
                                    <em class="parameter"><code><span class="type">gint</span> end_segment</code></em>);</pre>
<p>Delete the segment range</p>
<p>This function deletes a segment range.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-range-delete.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_segment</p></td>
<td class="parameter_description"><p>The index of the first segment to operate on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_segment</p></td>
<td class="parameter_description"><p>The index of the last segment to operate on. If negative, the selection will extend to the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-range-delete.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-range-redistribute-handles"></a><h3>gimp_gradient_segment_range_redistribute_handles ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_range_redistribute_handles
                               (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> start_segment</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> end_segment</code></em>);</pre>
<p>Uniformly redistribute the segment range's handles</p>
<p>This function redistributes the handles of the specified segment
range of the specified gradient, so they'll be evenly spaced.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-range-redistribute-handles.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_segment</p></td>
<td class="parameter_description"><p>The index of the first segment to operate on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_segment</p></td>
<td class="parameter_description"><p>The index of the last segment to operate on. If negative, the selection will extend to the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-range-redistribute-handles.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-range-blend-colors"></a><h3>gimp_gradient_segment_range_blend_colors ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_range_blend_colors
                               (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> start_segment</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> end_segment</code></em>);</pre>
<p>Blend the colors of the segment range.</p>
<p>This function blends the colors (but not the opacity) of the
segments' range of the gradient. Using it, the colors' transition
will be uniform across the range.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-range-blend-colors.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_segment</p></td>
<td class="parameter_description"><p>The index of the first segment to operate on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_segment</p></td>
<td class="parameter_description"><p>The index of the last segment to operate on. If negative, the selection will extend to the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-range-blend-colors.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-range-blend-opacity"></a><h3>gimp_gradient_segment_range_blend_opacity ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gradient_segment_range_blend_opacity
                               (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> start_segment</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> end_segment</code></em>);</pre>
<p>Blend the opacity of the segment range.</p>
<p>This function blends the opacity (but not the colors) of the
segments' range of the gradient. Using it, the opacity's transition
will be uniform across the range.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-range-blend-opacity.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_segment</p></td>
<td class="parameter_description"><p>The index of the first segment to operate on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_segment</p></td>
<td class="parameter_description"><p>The index of the last segment to operate on. If negative, the selection will extend to the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-range-blend-opacity.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gradient-segment-range-move"></a><h3>gimp_gradient_segment_range_move ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
gimp_gradient_segment_range_move (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                  <em class="parameter"><code><span class="type">gint</span> start_segment</code></em>,
                                  <em class="parameter"><code><span class="type">gint</span> end_segment</code></em>,
                                  <em class="parameter"><code><span class="type">gdouble</span> delta</code></em>,
                                  <em class="parameter"><code><span class="type">gboolean</span> control_compress</code></em>);</pre>
<p>Move the position of an entire segment range by a delta.</p>
<p>This function moves the position of an entire segment range by a
delta. The actual delta (which is returned) will be limited by the
control points of the neighboring segments.</p>
<div class="refsect3">
<a name="gimp-gradient-segment-range-move.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The gradient name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_segment</p></td>
<td class="parameter_description"><p>The index of the first segment to operate on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_segment</p></td>
<td class="parameter_description"><p>The index of the last segment to operate on. If negative, the selection will extend to the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>delta</p></td>
<td class="parameter_description"><p>The delta to move the segment range.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>control_compress</p></td>
<td class="parameter_description"><p>Whether or not to compress the neighboring segments.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gradient-segment-range-move.returns"></a><h4>Returns</h4>
<p> The final delta by which the range moved.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>